Skip to main content
Feedback

Summary - All Packages or Services

The Packages or Services - Summary page provides a snapshot of Packages, Services, Traffic Distribution, and Capacity Centers among deployment types. On this page, you can view reports for All Packages or Services or a particular Package or Service.

The following reports are available on the All Packages or Services - Summary page:

API Usage Report (for All APIs)

In this section, sparklines are plotted on a graph to communicate the overall trend of the three categories: Successful API Calls, Blocked Calls, and Other Responses. Refer to API Usage for more information.

API Usage: Fields and Descriptions

The following table describes the fields in the API usage section on the Packages or Services page:

FieldDescription
Successful API CallsCalls that go through the Traffic Manager without getting blocked or returning any error.
Blocked Calls

Calls that return a 403 error for any of the following reasons:

1. Quota or throttle limit is crossed.

2. Developer is inactive.

3. Developer is not authorized.

4. The referrer is unknown.

Other Responses

Calls that neither pass through the Traffic Manager nor return the 403 error. They include responses such as:

1. Timeout

2. Invalid key

3. Invalid signatures

4. Resource not found

5. HTTP 3xx series errors

Total API CallsThe total number of calls made in the selected date range.

API Calls by Package or Service Type Report

On the Packages or Services pages - API Calls by Package and Type or API Calls by Service and Type sections, the report displays a stacked area chart showing the trends in API calls made to API Packages or Services over a specified period. It also graphically displays the numerical data represented in the Package or API list report.

You can also filter a similar report by Total Calls, Successful Calls, Blocked Calls, and Other Calls in these sections - API Calls by Package and Type and API Calls by Service and Type.

List of Packages or APIs Report

This section includes the list of all Packages (Analyze > Packages) or APIs (Analyze > Packages >Services). You can view the reports pertaining to a particular Package or API by clicking the <your Package name> or <your API name>. This opens the Overview page for a specific Package or API, where you can filter the API or Package list reports.

Package and API List: Fields and Descriptions

The following table describes the fields in the Package and API list on the Packages or Services page.

FieldDescription
Packages and APIThe Package or API name.
SuccessfulNumber of successful calls.
Blocked

Calls that return a 403 error for any of the following reasons:

1. Quota or throttle limit is crossed.

2. Developer is inactive.

3. Developer is not authorized.

4. The referrer is unknown.

Other

Calls that neither pass through the Traffic Manager nor return a 403 error. They include responses such as:

1. Timeout

2. Invalid key

3. Invalid signatures

4. Resource not found

5. HTTP 3xx series errors

TotalTotal number of calls made to the API or the Package.
ChangeThe unit change in total traffic was recorded compared to the previous period.

Traffic Distribution Report

The Traffic Distribution report displays the API calls made in the respective deployment type for a specified date range.

List of Capacity Centers Report

A capacity center refers to a capacity cluster within a deployment type. Multiple capacity centers can be within a deployment type. For example, Boomi Cloud API Management - Local Edition allows clients to define one or more capacity centers.

Capacity Center List: Fields and Descriptions

The following table describes the fields in the Capacity Center list on the Packages or Services page:

FieldDescription
Capacity CenterThe capacity center name.
SuccessfulNumber of successful calls.
Blocked

Calls that return a 403 error for any of the following reasons:

1. Quota or throttle limit is crossed.

2. Developer is inactive.

3. Developer is not authorized.

4. The referrer is unknown.

Other

Calls that neither pass through the Traffic Manager nor return a 403 error. They include responses such as:

1. Timeout

2. Invalid key

3. Invalid signatures

4. Resource not found

5. HTTP 3xx series errors

TotalTotal number of calls made to the capacity center.
ChangeThe unit change in total traffic from the previous period was recorded.

Next Steps

Access, filter, and download All Package or Service reports by an API, Custom Date Range, or API Plan. Refer to Accessing or Filtering Reports and Download Reports for more information.

On this Page